Skip to main content
Feedback

How to connect to Apigee- Keyless — GCP hosted (Application Default Credentials)

There are several authentication options when connecting to Apigee. Use this option if your agent runs on Google Cloud compute (Compute Engine, GKE). With this option, there is no credential file to manage. The agent automatically uses whatever Google Cloud identity is already attached to the compute it's running on.

Prerequisites

  • Create (or reuse) a Google Cloud service account with Apigee permissions (for example, roles/apigee.apiAdminV2).
  • Attach that service account directly to the compute running your agent:
    • Compute Engine VM: set --service-account=<sa-email> --scopes=cloud-platform when creating the VM.
    • GKE: enable Workload Identity on your cluster, bind a Kubernetes ServiceAccount to the Google Cloud service account, and set that ServiceAccount on your agent's pod.

Connect to Apigee

  1. In API Control Plane, select Environments > Register Gateway.
  2. Select Apigee API Management.

Choose Platform Type

  1. Add the following:

    • Gateway Name
    • Organization
    • Authentication Method : **Keyless-GCP hosted (Application Default Credentials)
    • Developer

  2. Select Next.

  3. Select Download and Next. Your configuration file will download automatically.

Variables

  • image The docker image of the API Control Plane Agent
    • container_name You can change the name of your Agent here
    • environment
      • backendUrl The agent will establish a web-socket to this URL and connect to your API Control Plane.
      • agentToken
      • gateway.type
      • gateway.organization
      • gateway.googleAuthFile
      • gateway.developer
      • gateway.gatewayEnvironments=test-env,prod-env List of environments
    • volumes

Check the Agent's Status

  1. In API Control Plane, select Environments. Your agent is now connected to API Control Plane.

  2. Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be very useful in case of an error.

On this Page